<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Timer Functions</title>
<title>CMSIS-FreeRTOS: Timer Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 46px;">
  <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">CMSIS-FreeRTOS
   &#160;<span id="projectnumber">Version 9.0.0</span>
   </div>
   <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
    <ul class="tablist">
      <script type="text/javascript">
		<!--
		writeComponentTabs.call(this);
		//-->
      </script>
	  </ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
      <li><a href="modules.html"><span>Reference</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__freertos__evr__timers.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Timer Functions<div class="ingroups"><a class="el" href="group__freertos__evr.html">Event functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Events generated by timer functions.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gacc9345d117387a048a35832be8875b1f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__timers.html#gacc9345d117387a048a35832be8875b1f">EvrFreeRTOSTimers_TimerCreate</a> (Timer_t pxNewTimer)</td></tr>
<tr class="memdesc:gacc9345d117387a048a35832be8875b1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful timer object create (Op)  <a href="#gacc9345d117387a048a35832be8875b1f">More...</a><br/></td></tr>
<tr class="separator:gacc9345d117387a048a35832be8875b1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4d3ee3a0c730e52f53662b6d471a6678"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__timers.html#ga4d3ee3a0c730e52f53662b6d471a6678">EvrFreeRTOSTimers_TimerCreateFailed</a> (void)</td></tr>
<tr class="memdesc:ga4d3ee3a0c730e52f53662b6d471a6678"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on unsuccessful timer object create (Error)  <a href="#ga4d3ee3a0c730e52f53662b6d471a6678">More...</a><br/></td></tr>
<tr class="separator:ga4d3ee3a0c730e52f53662b6d471a6678"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab0b740245ecdbd07ca7d63c26ef249fc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__timers.html#gab0b740245ecdbd07ca7d63c26ef249fc">EvrFreeRTOSTimers_TimerCommandSend</a> (Timer_t pxTimer, uint32_t xCommandID, uint32_t xOptionalValue, uint32_t xReturn)</td></tr>
<tr class="memdesc:gab0b740245ecdbd07ca7d63c26ef249fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on timer queue command send (Op)  <a href="#gab0b740245ecdbd07ca7d63c26ef249fc">More...</a><br/></td></tr>
<tr class="separator:gab0b740245ecdbd07ca7d63c26ef249fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga67fb64cd979312c3584c6be7bd8affff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__timers.html#ga67fb64cd979312c3584c6be7bd8affff">EvrFreeRTOSTimers_TimerCommandReceived</a> (Timer_t pxTimer, uint32_t xCommandID, uint32_t xOptionalValue)</td></tr>
<tr class="memdesc:ga67fb64cd979312c3584c6be7bd8affff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on timer queue command receive (Op)  <a href="#ga67fb64cd979312c3584c6be7bd8affff">More...</a><br/></td></tr>
<tr class="separator:ga67fb64cd979312c3584c6be7bd8affff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6d29aabccac31d30777625064495e0f9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__timers.html#ga6d29aabccac31d30777625064495e0f9">EvrFreeRTOSTimers_TimerExpired</a> (Timer_t pxTimer)</td></tr>
<tr class="memdesc:ga6d29aabccac31d30777625064495e0f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on timer expire (Op)  <a href="#ga6d29aabccac31d30777625064495e0f9">More...</a><br/></td></tr>
<tr class="separator:ga6d29aabccac31d30777625064495e0f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4b35fa6a01c96b3395a4c49143a150d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__timers.html#ga4b35fa6a01c96b3395a4c49143a150d4">EvrFreeRTOSTimers_PendFuncCall</a> (PendedFunction_t pxFunctionToPend, void *pvParameter1, uint32_t ulParameter2, uint32_t xReturn)</td></tr>
<tr class="memdesc:ga4b35fa6a01c96b3395a4c49143a150d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on pass of the function execution to the timer service task (Op)  <a href="#ga4b35fa6a01c96b3395a4c49143a150d4">More...</a><br/></td></tr>
<tr class="separator:ga4b35fa6a01c96b3395a4c49143a150d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga870fe8028016271f6ef11061fbe82fcd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__timers.html#ga870fe8028016271f6ef11061fbe82fcd">EvrFreeRTOSTimers_PendFuncCallFromIsr</a> (PendedFunction_t pxFunctionToPend, void *pvParameter1, uint32_t ulParameter2, uint32_t xReturn)</td></tr>
<tr class="memdesc:ga870fe8028016271f6ef11061fbe82fcd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on pass of the function execution to the timer service task from the ISR (Op)  <a href="#ga870fe8028016271f6ef11061fbe82fcd">More...</a><br/></td></tr>
<tr class="separator:ga870fe8028016271f6ef11061fbe82fcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga4b35fa6a01c96b3395a4c49143a150d4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EvrFreeRTOSTimers_PendFuncCall </td>
          <td>(</td>
          <td class="paramtype">PendedFunction_t&#160;</td>
          <td class="paramname"><em>pxFunctionToPend</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>pvParameter1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>ulParameter2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>xReturn</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pxFunctionToPend</td><td>pointer to callback function </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">pvParameter1</td><td>function parameter 1. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">ulParameter2</td><td>function parameter 2. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xReturn</td><td>return value.</td></tr>
  </table>
  </dd>
</dl>
<p>The event <b>PendFuncCall</b> is generated before the function xTimerPendFunctionCall returns.</p>
<p><b>Value</b> in the Event Recorder shows:</p>
<ul>
<li><b>pxFunctionToPend</b> : callback function to execute from the timer service/deamon task.</li>
<li><b>pvParameter1</b> : the value passed into the callback function as the first parameter.</li>
<li><b>ulParameter2</b> : the value passed into the callback function as the second parameter.</li>
<li><b>xReturn</b> : execution status (1=callback passed to the timer sevice task, any other value: queue full, failed to register the callback execution) </li>
</ul>

</div>
</div>
<a class="anchor" id="ga870fe8028016271f6ef11061fbe82fcd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EvrFreeRTOSTimers_PendFuncCallFromIsr </td>
          <td>(</td>
          <td class="paramtype">PendedFunction_t&#160;</td>
          <td class="paramname"><em>pxFunctionToPend</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>pvParameter1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>ulParameter2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>xReturn</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pxFunctionToPend</td><td>pointer to callback function </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">pvParameter1</td><td>function parameter 1. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">ulParameter2</td><td>function parameter 2. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xReturn</td><td>return value.</td></tr>
  </table>
  </dd>
</dl>
<p>The event <b>PendFuncCallFromIsr</b> is generated before the function xTimerPendFunctionCallFromISR returns.</p>
<p><b>Value</b> in the Event Recorder shows:</p>
<ul>
<li><b>pxFunctionToPend</b> : callback function to execute from the timer service/deamon task.</li>
<li><b>pvParameter1</b> : the value passed into the callback function as the first parameter.</li>
<li><b>ulParameter2</b> : the value passed into the callback function as the second parameter.</li>
<li><b>xReturn</b> : execution status (1=callback passed to the timer sevice task, any other value: queue full, failed to register the callback execution) </li>
</ul>

</div>
</div>
<a class="anchor" id="ga67fb64cd979312c3584c6be7bd8affff"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EvrFreeRTOSTimers_TimerCommandReceived </td>
          <td>(</td>
          <td class="paramtype">Timer_t&#160;</td>
          <td class="paramname"><em>pxTimer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>xCommandID</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>xOptionalValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pxTimer</td><td>pointer to timer object handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xCommandID</td><td>timer command ID. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xOptionalValue</td><td>optional command value.</td></tr>
  </table>
  </dd>
</dl>
<p>The event <b>TimerCommandReceived</b> is generated when the timer service task receives a command and before the command is actually processed.</p>
<p><b>Value</b> in the Event Recorder shows:</p>
<ul>
<li><b>pxTimer</b> : pointer to timer object handle (control block address).</li>
<li><b>xCommandID</b> : timer command ID.</li>
<li><b>xOptionalValue</b> : optional command value. </li>
</ul>

</div>
</div>
<a class="anchor" id="gab0b740245ecdbd07ca7d63c26ef249fc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EvrFreeRTOSTimers_TimerCommandSend </td>
          <td>(</td>
          <td class="paramtype">Timer_t&#160;</td>
          <td class="paramname"><em>pxTimer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>xCommandID</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>xOptionalValue</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>xReturn</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pxTimer</td><td>pointer to timer object handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xCommandID</td><td>timer command ID. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xOptionalValue</td><td>optional command value. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xReturn</td><td>return value.</td></tr>
  </table>
  </dd>
</dl>
<p>The event <b>TimerCommandSend</b> is generated when a command is sent to the timer service task,</p>
<p><b>Value</b> in the Event Recorder shows:</p>
<ul>
<li><b>pxTimer</b> : pointer to timer object handle (control block address).</li>
<li><b>xCommandID</b> : timer command ID.</li>
<li><b>xOptionalValue</b> : optional command value.</li>
<li><b>xReturn</b> : execution status (0: failed, command was not sent to the timer command queue, 1: passed, command sent) </li>
</ul>

</div>
</div>
<a class="anchor" id="gacc9345d117387a048a35832be8875b1f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EvrFreeRTOSTimers_TimerCreate </td>
          <td>(</td>
          <td class="paramtype">Timer_t&#160;</td>
          <td class="paramname"><em>pxNewTimer</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pxNewTimer</td><td>pointer to timer object handle.</td></tr>
  </table>
  </dd>
</dl>
<p>The event <b>TimerCreate</b> is generated when timer object is successfully created.</p>
<p><b>Value</b> in the Event Recorder shows:</p>
<ul>
<li><b>pxNewTimer</b> : pointer to timer object handle (control block address). </li>
</ul>

</div>
</div>
<a class="anchor" id="ga4d3ee3a0c730e52f53662b6d471a6678"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EvrFreeRTOSTimers_TimerCreateFailed </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The event <b>TimerCreateFailed</b> is generated when timer object create fails due to insufficient heap memory. </p>

</div>
</div>
<a class="anchor" id="ga6d29aabccac31d30777625064495e0f9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EvrFreeRTOSTimers_TimerExpired </td>
          <td>(</td>
          <td class="paramtype">Timer_t&#160;</td>
          <td class="paramname"><em>pxTimer</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pxTimer</td><td>pointer to timer object handle.</td></tr>
  </table>
  </dd>
</dl>
<p>The event <b>TimerExpired</b> is generated when a software timer expires and before the timer callback is executed.</p>
<p><b>Value</b> in the Event Recorder shows:</p>
<ul>
<li><b>pxTimer</b> : pointer to timer object handle (control block address). </li>
</ul>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated on Mon Mar 13 2017 09:48:26 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
	<!--
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
	-->
	</li>
  </ul>
</div>
</body>
</html>
